﻿// Copyright 2012-2017 The Poderosa Project.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

namespace Granados.Poderosa.FileTransfer {

    /// <summary>
    /// A class to request a cancellation.
    /// </summary>
    public class Cancellation {

        #region Private fields

        private bool _requested = false;

        #endregion

        #region Properties

        /// <summary>
        /// Gets whether a cancellation has been requested.
        /// </summary>
        public bool IsRequested {
            get {
                return _requested;
            }
        }
        
        #endregion Properties

        #region Constructor

        /// <summary>
        /// Constructor
        /// </summary>
        public Cancellation() {
        }

        #endregion

        #region Methods

        /// <summary>
        /// Request cancellation.
        /// </summary>
        public void Cancel() {
            _requested = true;
        }

        #endregion
    }
}
